<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Sets file-specific meta-data saved with a file</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="pharfileinfo.setcompressedgz.html">PharFileInfo::setCompressedGZ</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.setuncompressed.html">PharFileInfo::setUncompressed</a></div>
 <div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pharfileinfo.setmetadata" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PharFileInfo::setMetadata</h1>
  <p class="verinfo">(PHP &gt;= 5.3.0, PECL phar &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">PharFileInfo::setMetadata</span> &mdash; <span class="dc-title">Sets file-specific meta-data saved with a file</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-pharfileinfo.setmetadata-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>PharFileInfo::setMetadata</strong></span>
    ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$metadata</code></span>
   )</div>


  <p class="para rdfs-comment">
   <span class="function"><strong>PharFileInfo::setMetadata()</strong></span> should only be used to store customized data in a file
   that cannot be represented with existing information stored with a file.
   Meta-data can significantly slow down the performance of loading a phar
   archive if the data is large, or if there are many files containing meta-data.
   It is important to note that file permissions are natively supported inside a
   phar; it is possible to set them with the
   <span class="function"><a href="pharfileinfo.chmod.html" class="function">PharFileInfo::chmod()</a></span> method.  As with all functionality that modifies the contents of
   a phar, the <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> INI variable
   must be off in order to succeed if the file is within a <a href="class.phar.html" class="classname">Phar</a>
   archive.  Files within <a href="class.phardata.html" class="classname">PharData</a> archives do not have
   this restriction.
  </p>
  <p class="para">
   Some possible uses for meta-data include passing a user/group that should be set
   when a file is extracted from the phar to disk.  Other uses could include
   explicitly specifying a MIME type to return.  However, any useful data that
   describes a file, but should not be contained inside of it may be stored.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-pharfileinfo.setmetadata-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<em><code class="parameter">metadata</code></em></dt>

     <dd>

      <p class="para">
       Any PHP variable containing information to store alongside a file
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-pharfileinfo.setmetadata-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   没有返回值。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-pharfileinfo.setmetadata-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-714">
    <p><strong>Example #1 A <span class="function"><strong>PharFileInfo::setMetadata()</strong></span> example</strong></p>
    <div class="example-contents"><p>
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//&nbsp;make&nbsp;sure&nbsp;it&nbsp;doesn't&nbsp;exist<br /></span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />try&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$p&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">'/brandnewphar.phar'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.txt'</span><span style="color: #007700">]&nbsp;=&nbsp;</span><span style="color: #DD0000">'hello'</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.txt'</span><span style="color: #007700">]-&gt;</span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'user'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'bill'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'mime-type'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'text/plain'</span><span style="color: #007700">));<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.txt'</span><span style="color: #007700">]-&gt;</span><span style="color: #0000BB">getMetaData</span><span style="color: #007700">());<br />}&nbsp;catch&nbsp;(</span><span style="color: #0000BB">Exception&nbsp;$e</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">'Could&nbsp;not&nbsp;create/modify&nbsp;phar:&nbsp;'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents"><p>以上例程会输出：</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
  [&quot;user&quot;]=&gt;
  string(4) &quot;bill&quot;
  [&quot;mime-type&quot;]=&gt;
  string(10) &quot;text/plain&quot;
}
</pre></div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-pharfileinfo.setmetadata-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="pharfileinfo.hasmetadata.html" class="function" rel="rdfs-seeAlso">PharFileInfo::hasMetadata()</a> - Returns the metadata of the entry</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.getmetadata.html" class="function" rel="rdfs-seeAlso">PharFileInfo::getMetadata()</a> - Returns file-specific meta-data saved with a file</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.delmetadata.html" class="function" rel="rdfs-seeAlso">PharFileInfo::delMetadata()</a> - Deletes the metadata of the entry</span></li>
    <li class="member"><span class="function"><a href="phardata.setmetadata.html" class="function" rel="rdfs-seeAlso">Phar::setMetadata()</a> - Sets phar archive meta-data</span></li>
    <li class="member"><span class="function"><a href="phar.hasmetadata.html" class="function" rel="rdfs-seeAlso">Phar::hasMetadata()</a> - Returns whether phar has global meta-data</span></li>
    <li class="member"><span class="function"><a href="phar.getmetadata.html" class="function" rel="rdfs-seeAlso">Phar::getMetadata()</a> - Returns phar archive meta-data</span></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="pharfileinfo.setcompressedgz.html">PharFileInfo::setCompressedGZ</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.setuncompressed.html">PharFileInfo::setUncompressed</a></div>
 <div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
